package com.lyx.rpc.common.scanner;

import com.sun.org.apache.xalan.internal.xsltc.dom.SimpleResultTreeImpl;

import java.io.File;
import java.io.FileFilter;
import java.io.IOException;
import java.net.JarURLConnection;
import java.net.URL;
import java.net.URLDecoder;
import java.nio.file.Files;
import java.util.ArrayList;
import java.util.Enumeration;
import java.util.List;
import java.util.jar.JarEntry;
import java.util.jar.JarFile;

/**
 * @Author by lyx
 * 通用的类扫描器
 */
public class ClassScanner {

    /**
     * 文件
     */
    private static final String PROTOCOL_FILE = "file";
    /**
     * jar包
     */
    private static final String PROTOCOL_JAR = "jar";
    /**
     * class文件的后缀
     */
    private static final String CLASS_FILE_SUFFIX = ".class";

    /**
     * 扫描指定包下的所有类信息
     *
     * 扫描指定包名下的所有类信息，并返回包含指定包下所有完整类名的列表集合。它可以处理本地文件系统中的包和 JAR 文件中的包。
     * 假设：
     * 本地项目中有一个包 com.example.myapp，其中包含以下内容：
     *      ClassOne.java：定义了一个名为 ClassOne 的类。
     *          subpackage 子包，其中包含 ClassTwo.java（定义了 ClassTwo 类）。
     *      有一个 JAR 文件 mylibrary.jar，其中包含包 com.example.library，该包中有 ClassThree.java（定义了 ClassThree 类）。
     * 调用 getClassNameList 方法后，该方法会通过当前线程的上下文类加载器获取与指定包名对应的所有资源的 URL 枚举。
     * 如果在本地文件系统中找到了与 com.example.myapp 对应的目录，并且协议为 file，则会调用 findAndAddClassesInPackageByFile方法扫描该目录下的所有类文件，
     * 并将类名添加到 classNameList 中。在这个例子中，会找到 com.example.myapp.ClassOne 和 com.example.myapp.subpackage.ClassTwo。
     * 如果在资源中找到了一个 JAR 文件，并且协议为 jar，则会调用 findAndAddClassesInPackageByJar 方法扫描 JAR 文件中的包，
     * 查找指定包名下的类，并将类名添加到 classNameList 中。假设这个例子中的 mylibrary.jar 被扫描到，会找到 com.example.library.ClassThree。
     * 最后，遍历 classNameList 并打印出找到的所有类名，输出可能如下：
     *          com.example.myapp.ClassOne
     *          com.example.myapp.subpackage.ClassTwo
     *          com.example.library.ClassThree（如果 mylibrary.jar 被扫描到）。
     * @param packageName 指定的包名
     * @return 指定包下所有完整类名的List集合
     * @throws Exception
     */
    public static List<String> getClassNameList(String packageName) throws Exception{
        //第一个class类的集合
        List<String> classNameList = new ArrayList<String>();
        //是否循环迭代
        boolean recursive = true;
        //获取包的名字 并进行替换
        String packageDirName = packageName.replace('.', '/');
        //定义一个枚举的集合 并进行循环来处理这个目录下的things
        Enumeration<URL> dirs = Thread.currentThread().getContextClassLoader().getResources(packageDirName);
        //循环迭代下去
        while (dirs.hasMoreElements()){
            //获取下一个元素
            URL url = dirs.nextElement();
            //得到协议的名称
            String protocol = url.getProtocol();
            //如果是以文件的形式保存在服务器上
            if (PROTOCOL_FILE.equals(protocol)) {
                //获取包的物理路径
                String filePath = URLDecoder.decode(url.getFile(), "UTF-8");
                //以文件的方式扫描整个包下的文件 并添加到集合中
                findAndAddClassesInPackageByFile(packageName, filePath, recursive, classNameList);
            } else if (PROTOCOL_JAR.equals(protocol)){
                packageName = findAndAddClassesInPackageByJar(packageName, classNameList, recursive, packageDirName, url);
            }
        }
        return classNameList;
    }

    /**
     * 扫描当前工程中指定包下的所有类信息
     *
     * 扫描当前工程中指定包下的所有类信息。它接受一个包名、包在磁盘上的完整路径、一个表示是否递归扫描子包的布尔值以及一个用于存储类名称的列表作为参数。
     * 通过遍历指定包及其子包（如果递归扫描）下的文件，找到所有的.class文件，并将对应的类名添加到给定的列表中。
     * 假设包结构如下：
     * com.example
     * ├── packageA
     * │   ├── ClassA.java
     * │   └── packageB
     * │       ├── ClassB.java
     * │       └── ClassC.java
     * └── packageC
     *     ├── ClassD.java
     *
     *     public static void main(String[] args) {
     *         String packageName = "com.example.packageA";
     *         String packagePath = "/path/to/your/project/com/example/packageA";
     *         boolean recursive = true;
     *         List<String> classNameList = new ArrayList<>();
     *         findAndAddClassesInPackageByFile(packageName, packagePath, recursive, classNameList);
     *         for (String className : classNameList) {
     *             System.out.println(className);
     *         }
     *     }
     *  这个结果就是 com.example.packageA.ClassA ，com.example.packageA.ClassB ，com.example.packageA.ClassC
     *
     * @param packageName 扫描的包名
     * @param packagePath 包在磁盘上的完整路径
     * @param recursive 是否递归调用
     * @param classNameList 类名称的集合
     */
    private static void findAndAddClassesInPackageByFile(String packageName, String packagePath, final boolean recursive, List<String> classNameList){
        //获取此包的目录 建立一个File
        File dir = new File(packagePath);
        //如果不存在或者 也不是目录就直接返回
        if (!dir.exists() || !dir.isDirectory()) {
            return;
        }
        //如果存在 就获取包下的所有文件 包括目录
        File[] dirfiles = dir.listFiles(new FileFilter() {
            //自定义过滤规则 如果可以循环(包含子目录) 或则是以.class结尾的文件(编译好的java类文件)
            public boolean accept(File file) {
                return (recursive && file.isDirectory()) || (file.getName().endsWith(".class"));
            }
        });
        //循环所有文件
        for (File file : dirfiles) {
            //如果是目录 则继续扫描
            if (file.isDirectory()) {
                findAndAddClassesInPackageByFile(packageName + "." + file.getName(),
                    file.getAbsolutePath(),
                    recursive,
                    classNameList);
            }else {
                //如果是java类文件 去掉后面的.class 只留下类名
                String className = file.getName().substring(0, file.getName().length() - 6);
                //添加到集合中去
                classNameList.add(packageName + '.' + className);
            }
        }
    }

    /**
     * 扫描Jar文件中指定包下的所有类信息
     *
     * 它接受包名、用于存储类名的列表、是否递归扫描的标志、当前包名的前面部分名称以及包的 URL 地址作为参数，
     * 并返回处理后的包名以便下次调用使用。通过遍历 Jar 文件中的条目，找到符合条件的类并将其类名添加到给定的列表中。
     *
     * 假设我们有一个 Jar 文件，其中包含以下结构：
     * com.example
     * ├── packageA
     * │   ├── ClassA.class
     * │   └── packageB
     * │       ├── ClassB.class
     * │       └── ClassC.class
     * └── packageC
     *     ├── ClassD.class
     *
     *     public static void main(String[] args) throws IOException {
     *         String packageName = "com.example.packageA";
     *         List<String> classNameList = new ArrayList<>();
     *         boolean recursive = true;
     *         String packageDirName = "com.example";
     *         URL url = new URL("path/to/your/jar/file.jar");
     *         String processedPackageName = findAndAddClassesInPackageByJar(packageName, classNameList, recursive, packageDirName, url);
     *         for (String className : classNameList) {
     *             System.out.println(className);
     *         }
     *     }
     *     将会找到com.example.packageA.ClassA、com.example.packageA.packageB.ClassB和com.example.packageA.packageB.ClassC这三个类
     *
     * @param packageName 扫描的包名
     * @param classNameList 完成类名存放的List集合
     * @param recursive 是否递归调用
     * @param packageDirName 当前包名的前面部分的名称
     * @param url 包的url地址
     * @return 处理后的包名，以供下次调用使用
     * @throws IOException
     */
    private static String findAndAddClassesInPackageByJar(String packageName, List<String> classNameList, boolean recursive, String packageDirName, URL url) throws IOException {
        //如果是jar包文件
        //定义一个JarFile
        JarFile jar = ((JarURLConnection) url.openConnection()).getJarFile();
        //从此jar包 得到一个枚举类
        Enumeration<JarEntry> entries = jar.entries();
        //同样的进行循环迭代
        while (entries.hasMoreElements()) {
            //获取jar里的一个实体 可以是目录 和一些jar包里的其他文件 如META-INF等文件
            JarEntry entry = entries.nextElement();
            String name = entry.getName();
            //如果是以/开头的
            if (name.charAt(0) == '/') {
                //获取后面的字符串
                name = name.substring(1);
            }
            //如果前半部分和定义的包名相同
            if (name.startsWith(packageDirName)) {
                int idx = name.lastIndexOf('/');
                //如果以"/"结尾 是一个包
                if (idx != -1) {
                    //获取包名 把"/"替换成"."
                    packageName = name.substring(0, idx).replace('/', '.');
                }
                //如果可以迭代下去 并且是一个包
                if ((idx != -1) || recursive){
                    //如果是一个.class文件 而且不是目录
                    if (name.endsWith(CLASS_FILE_SUFFIX) && !entry.isDirectory()) {
                        //去掉后面的".class" 获取真正的类名
                        String className = name.substring(packageName.length() + 1, name.length() - 6);
                        classNameList.add(packageName + '.' + className);
                    }
                }
            }
        }
        return packageName;
    }

}
